Operation Repository.PageProvider (PageProvider)

In component org.nuxeo.ecm.core.automation.features.operations

Description

Perform a named provider query on the repository. Result is paginated. The query result will become the input for the next operation.

Operation id	Repository.PageProvider
Aliases	`Document.PageProvider`
Category	Fetch
Label	PageProvider
Requires
Since

Parameters

Name	Description	Type	Required	Default value
providerName		string	yes
currentPageIndex		integer	no
documentLinkBuilder		string	no
highlights	Highlight properties (separated by comma)	stringlist	no
language		string	no	NXQL
namedParameters	Named parameters to pass to the page provider to fill in query variables.	properties	no
offset		integer	no
pageSize		integer	no
queryParams		stringlist	no
quickFilters	Quick filter properties (separated by comma)	stringlist	no
sortBy	Sort by properties (separated by comma)	stringlist	no
sortOrder	Sort order, ASC or DESC	stringlist	no	ASC, DESC

Signature

Inputs	void
Outputs	documents

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.services.DocumentPageProviderOperation
Contributing Component	org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "Repository.PageProvider",
  "aliases" : [ "Document.PageProvider" ],
  "label" : "PageProvider",
  "category" : "Fetch",
  "requires" : null,
  "description" : "Perform a named provider query on the repository. Result is paginated. The query result will become the input for the next operation.",
  "url" : "Repository.PageProvider",
  "signature" : [ "void", "documents" ],
  "params" : [ {
    "name" : "providerName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "currentPageIndex",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "documentLinkBuilder",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "highlights",
    "description" : "Highlight properties (separated by comma)",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "language",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "NXQL" ]
  }, {
    "name" : "namedParameters",
    "description" : "Named parameters to pass to the page provider to fill in query variables.",
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "offset",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pageSize",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryParams",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "quickFilters",
    "description" : "Quick filter properties (separated by comma)",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortBy",
    "description" : "Sort by properties (separated by comma)",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortOrder",
    "description" : "Sort order, ASC or DESC",
    "type" : "stringlist",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "ASC", "DESC" ]
  } ]
}